lteiot16.h File Reference

This file contains API for LTE IoT 16 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"

Go to the source code of this file.

Data Structures
struct	lteiot16_t
	LTE IoT 16 Click context object. More...
struct	lteiot16_cfg_t
	LTE IoT 16 Click configuration object. More...

Macros
#define	LTEIOT16_CMD_AT   "AT"
	LTE IoT 16 control commands.
#define	LTEIOT16_CMD_GET_MODEL_ID   "AT+CGMM"
#define	LTEIOT16_CMD_GET_SW_VERSION   "AT+CGMR"
#define	LTEIOT16_CMD_GET_SERIAL_NUM   "AT+CGSN"
#define	LTEIOT16_CMD_FACTORY_RESET   "AT&F"
#define	LTEIOT16_CMD_SET_MODULE_FUNCTIONALITY   "AT+CFUN"
#define	LTEIOT16_CMD_EPS_NETWORK_REGISTRATION   "AT+CEREG"
#define	LTEIOT16_CMD_SIGNAL_QUALITY_REPORT   "AT+CSQ"
#define	LTEIOT16_CMD_OPERATOR_SELECTION   "AT+COPS"
#define	LTEIOT16_CMD_SEND_SMS   "AT+CMGS"
#define	LTEIOT16_CMD_SELECT_SMS_FORMAT   "AT+CMGF"
#define	LTEIOT16_CMD_DEFINE_PDP_CONTEXT   "AT+CGDCONT"
#define	LTEIOT16_CMD_SHOW_PDP_ADDRESS   "AT+CGPADDR"
#define	LTEIOT16_CMD_ACTIVATE_PDP_CONTEXT   "AT+CGACT"
#define	LTEIOT16_CMD_PSD_CONFIG   "AT+UPSD"
#define	LTEIOT16_CMD_PSD_ACTION   "AT+UPSDA"
#define	LTEIOT16_CMD_CREATE_SOCKET   "AT+USOCR"
#define	LTEIOT16_CMD_CLOSE_SOCKET   "AT+USOCL"
#define	LTEIOT16_CMD_CONNECT_SOCKET   "AT+USOCO"
#define	LTEIOT16_CMD_WRITE_SOCKET_DATA   "AT+USOWR"
#define	LTEIOT16_CMD_READ_SOCKET_DATA   "AT+USORD"
#define	LTEIOT16_CMD_GPIO_CONFIG   "AT+UGPIOC"
#define	LTEIOT16_CMD_GNSS_POWER_MANAGEMENT   "AT+UGPS"
#define	LTEIOT16_CMD_GET_GNSS_FIX_DATA   "AT+UGGGA"
#define	LTEIOT16_RSP_OK   "OK"
	LTE IoT 16 device response for AT commands.
#define	LTEIOT16_RSP_ERROR   "ERROR"
#define	LTEIOT16_URC_CREATE_SOCKET   "+USOCR: "
	LTE IoT 16 device unsolicited response code (URC) settings.
#define	LTEIOT16_URC_RECEIVED_DATA   "+UUSORD: "
#define	LTEIOT16_POWER_STATE_OFF   0
	LTE IoT 16 power state settings.
#define	LTEIOT16_POWER_STATE_ON   1
#define	LTEIOT16_POWER_STATE_RESET   2
#define	LTEIOT16_RSP_START   "$"
	LTE IoT 16 response buffer commands.
#define	LTEIOT16_RSP_DELIMITER   ","
#define	LTEIOT16_RSP_END   "\r\n"
#define	LTEIOT16_RSP_GGA   "GGA"
#define	LTEIOT16_GGA_ELEMENT_SIZE   15
	LTE IoT 16 GGA command elements.
#define	LTEIOT16_GGA_TIME   1
#define	LTEIOT16_GGA_LATITUDE   2
#define	LTEIOT16_GGA_LATITUDE_SIDE   3
#define	LTEIOT16_GGA_LONGITUDE   4
#define	LTEIOT16_GGA_LONGITUDE_SIDE   5
#define	LTEIOT16_GGA_QUALITY_INDICATOR   6
#define	LTEIOT16_GGA_NUMBER_OF_SATELLITES   7
#define	LTEIOT16_GGA_H_DILUTION_OF_POS   8
#define	LTEIOT16_GGA_ALTITUDE   9
#define	LTEIOT16_GGA_ALTITUDE_UNIT   10
#define	LTEIOT16_GGA_GEOIDAL_SEPARATION   11
#define	LTEIOT16_GGA_GEOIDAL_SEPARATION_UNIT   12
#define	LTEIOT16_GGA_TIME_SINCE_LAST_DGPS   13
#define	LTEIOT16_GGA_DGPS_REFERENCE_STATION_ID   14
#define	LTEIOT16_TX_DRV_BUFFER_SIZE   300
	LTE IoT 16 driver buffer size.
#define	LTEIOT16_RX_DRV_BUFFER_SIZE   300
#define	LTEIOT16_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	lteiot16_return_value_t { LTEIOT16_OK = 0 , LTEIOT16_ERROR = -1 , LTEIOT16_ERROR_TIMEOUT = -2 , LTEIOT16_ERROR_CMD = -3 }
	LTE IoT 16 Click return value data. More...

Functions
void	lteiot16_cfg_setup (lteiot16_cfg_t *cfg)
	LTE IoT 16 configuration object setup function.
err_t	lteiot16_init (lteiot16_t *ctx, lteiot16_cfg_t *cfg)
	LTE IoT 16 initialization function.
err_t	lteiot16_generic_write (lteiot16_t *ctx, uint8_t *data_in, uint16_t len)
	LTE IoT 16 data writing function.
err_t	lteiot16_generic_read (lteiot16_t *ctx, uint8_t *data_out, uint16_t len)
	LTE IoT 16 data reading function.
void	lteiot16_set_pwr_pin (lteiot16_t *ctx, uint8_t state)
	LTE IoT 16 set PWR pin function.
void	lteiot16_set_rst_pin (lteiot16_t *ctx, uint8_t state)
	LTE IoT 16 set RST pin function.
void	lteiot16_set_rts_pin (lteiot16_t *ctx, uint8_t state)
	LTE IoT 16 set RTS pin function.
uint8_t	lteiot16_get_ring_pin (lteiot16_t *ctx)
	LTE IoT 16 get RING pin function.
uint8_t	lteiot16_get_cts_pin (lteiot16_t *ctx)
	LTE IoT 16 get CTS pin function.
void	lteiot16_set_power_state (lteiot16_t *ctx, uint8_t state)
	LTE IoT 16 set power state function.
void	lteiot16_cmd_run (lteiot16_t *ctx, uint8_t *cmd)
	LTE IoT 16 cmd run function.
void	lteiot16_cmd_set (lteiot16_t *ctx, uint8_t *cmd, uint8_t *value)
	LTE IoT 16 cmd set function.
void	lteiot16_cmd_get (lteiot16_t *ctx, uint8_t *cmd)
	LTE IoT 16 cmd get function.
void	lteiot16_cmd_help (lteiot16_t *ctx, uint8_t *cmd)
	LTE IoT 16 cmd help function.
void	lteiot16_set_sim_apn (lteiot16_t *ctx, uint8_t *sim_apn)
	Set sim card APN.
void	lteiot16_send_sms_text (lteiot16_t *ctx, uint8_t *phone_number, uint8_t *sms_text)
	LTE IoT 16 send SMS in text mode.
err_t	lteiot16_send_sms_pdu (lteiot16_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text)
	LTE IoT 16 send SMS in PDU mode.
err_t	lteiot16_parse_gga (uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data)
	LTE IoT 16 parse GGA function.

Detailed Description

This file contains API for LTE IoT 16 Click Driver.

Enumeration Type Documentation

lteiot16_return_value_t

enum lteiot16_return_value_t

LTE IoT 16 Click return value data.

Predefined enum values for driver return values.

Enumerator
LTEIOT16_OK
LTEIOT16_ERROR
LTEIOT16_ERROR_TIMEOUT
LTEIOT16_ERROR_CMD